package com.ruoyi.generator.domain;

import java.util.List;
import javax.validation.Valid;
import javax.validation.constraints.NotBlank;

import org.apache.commons.lang3.ArrayUtils;
import com.ruoyi.common.constant.GenConstants;
import com.ruoyi.common.core.domain.BaseEntity;
import com.ruoyi.common.utils.StringUtils;

/**
 * 业务表 gen_table
 * <p>
 * 用于表示数据库中的一张表及其相关信息，包括表结构、生成配置等。
 * </p>
 *
 * @author ruoyi
 */
public class GenTable extends BaseEntity {
    private static final long serialVersionUID = 1L;

    /**
     * 编号 - 数据库中的唯一标识符
     */
    private Long tableId;

    /**
     * 表名称 - 对应数据库中的实际表名
     */
    @NotBlank(message = "表名称不能为空")
    private String tableName;

    /**
     * 表描述 - 描述该表的作用或含义
     */
    @NotBlank(message = "表描述不能为空")
    private String tableComment;

    /**
     * 关联父表的表名 - 当前表作为子表时所关联的父表名称
     */
    private String subTableName;

    /**
     * 本表关联父表的外键名 - 指向父表主键的字段名
     */
    private String subTableFkName;

    /**
     * 实体类名称(首字母大写) - Java实体类对应的类名
     */
    @NotBlank(message = "实体类名称不能为空")
    private String className;

    /**
     * 使用的模板（crud单表操作 tree树表操作 sub主子表操作）- 决定生成代码的方式
     */
    private String tplCategory;

    /**
     * 前端类型（element-ui模版 element-plus模版）- 控制前端页面使用的UI框架
     */
    private String tplWebType;

    /**
     * 生成包路径 - Java类所在的包路径
     */
    @NotBlank(message = "生成包路径不能为空")
    private String packageName;

    /**
     * 生成模块名 - 所属系统模块名称
     */
    @NotBlank(message = "生成模块名不能为空")
    private String moduleName;

    /**
     * 生成业务名 - 当前功能所属的业务领域
     */
    @NotBlank(message = "生成业务名不能为空")
    private String businessName;

    /**
     * 生成功能名 - 功能模块的具体名称
     */
    @NotBlank(message = "生成功能名不能为空")
    private String functionName;

    /**
     * 生成作者 - 负责开发此功能的人员姓名
     */
    @NotBlank(message = "作者不能为空")
    private String functionAuthor;

    /**
     * 生成代码方式（0zip压缩包 1自定义路径）- 控制输出文件的形式
     */
    private String genType;

    /**
     * 生成路径（不填默认项目路径）- 自定义生成文件保存的位置
     */
    private String genPath;

    /**
     * 主键信息 - 包含当前表主键的相关属性
     */
    private GenTableColumn pkColumn;

    /**
     * 子表信息 - 若为主表则包含其对应的所有子表对象
     */
    private GenTable subTable;

    /**
     * 表列信息 - 包括所有字段的信息列表
     */
    @Valid
    private List<GenTableColumn> columns;

    /**
     * 其它生成选项 - 额外的配置参数以JSON格式存储
     */
    private String options;

    /**
     * 树编码字段 - 在树形结构中代表节点编号的字段
     */
    private String treeCode;

    /**
     * 树父编码字段 - 表示上级节点编号的字段
     */
    private String treeParentCode;

    /**
     * 树名称字段 - 显示在界面上的节点名称字段
     */
    private String treeName;

    /**
     * 上级菜单ID字段 - 页面跳转所需的目标菜单ID
     */
    private Long parentMenuId;

    /**
     * 上级菜单名称字段 - 显示用的菜单标题
     */
    private String parentMenuName;

    /**
     * 获取表ID
     *
     * @return 表ID
     */
    public Long getTableId() {
        return tableId;
    }

    /**
     * 设置表ID
     *
     * @param tableId 表ID
     */
    public void setTableId(Long tableId) {
        this.tableId = tableId;
    }

    /**
     * 获取表名称
     *
     * @return 表名称
     */
    public String getTableName() {
        return tableName;
    }

    /**
     * 设置表名称
     *
     * @param tableName 表名称
     */
    public void setTableName(String tableName) {
        this.tableName = tableName;
    }

    /**
     * 获取表描述
     *
     * @return 表描述
     */
    public String getTableComment() {
        return tableComment;
    }

    /**
     * 设置表描述
     *
     * @param tableComment 表描述
     */
    public void setTableComment(String tableComment) {
        this.tableComment = tableComment;
    }

    /**
     * 获取子表名
     *
     * @return 子表名
     */
    public String getSubTableName() {
        return subTableName;
    }

    /**
     * 设置子表名
     *
     * @param subTableName 子表名
     */
    public void setSubTableName(String subTableName) {
        this.subTableName = subTableName;
    }

    /**
     * 获取子表外键名
     *
     * @return 外键名
     */
    public String getSubTableFkName() {
        return subTableFkName;
    }

    /**
     * 设置子表外键名
     *
     * @param subTableFkName 外键名
     */
    public void setSubTableFkName(String subTableFkName) {
        this.subTableFkName = subTableFkName;
    }

    /**
     * 获取实体类名称
     *
     * @return 类名
     */
    public String getClassName() {
        return className;
    }

    /**
     * 设置实体类名称
     *
     * @param className 类名
     */
    public void setClassName(String className) {
        this.className = className;
    }

    /**
     * 获取模板类别
     *
     * @return 模板类别
     */
    public String getTplCategory() {
        return tplCategory;
    }

    /**
     * 设置模板类别
     *
     * @param tplCategory 模板类别
     */
    public void setTplCategory(String tplCategory) {
        this.tplCategory = tplCategory;
    }

    /**
     * 获取前端模板类型
     *
     * @return 前端模板类型
     */
    public String getTplWebType() {
        return tplWebType;
    }

    /**
     * 设置前端模板类型
     *
     * @param tplWebType 前端模板类型
     */
    public void setTplWebType(String tplWebType) {
        this.tplWebType = tplWebType;
    }

    /**
     * 获取包路径
     *
     * @return 包路径
     */
    public String getPackageName() {
        return packageName;
    }

    /**
     * 设置包路径
     *
     * @param packageName 包路径
     */
    public void setPackageName(String packageName) {
        this.packageName = packageName;
    }

    /**
     * 获取模块名
     *
     * @return 模块名
     */
    public String getModuleName() {
        return moduleName;
    }

    /**
     * 设置模块名
     *
     * @param moduleName 模块名
     */
    public void setModuleName(String moduleName) {
        this.moduleName = moduleName;
    }

    /**
     * 获取业务名
     *
     * @return 业务名
     */
    public String getBusinessName() {
        return businessName;
    }

    /**
     * 设置业务名
     *
     * @param businessName 业务名
     */
    public void setBusinessName(String businessName) {
        this.businessName = businessName;
    }

    /**
     * 获取功能名
     *
     * @return 功能名
     */
    public String getFunctionName() {
        return functionName;
    }

    /**
     * 设置功能名
     *
     * @param functionName 功能名
     */
    public void setFunctionName(String functionName) {
        this.functionName = functionName;
    }

    /**
     * 获取作者
     *
     * @return 作者
     */
    public String getFunctionAuthor() {
        return functionAuthor;
    }

    /**
     * 设置作者
     *
     * @param functionAuthor 作者
     */
    public void setFunctionAuthor(String functionAuthor) {
        this.functionAuthor = functionAuthor;
    }

    /**
     * 获取生成方式
     *
     * @return 生成方式
     */
    public String getGenType() {
        return genType;
    }

    /**
     * 设置生成方式
     *
     * @param genType 生成方式
     */
    public void setGenType(String genType) {
        this.genType = genType;
    }

    /**
     * 获取生成路径
     *
     * @return 生成路径
     */
    public String getGenPath() {
        return genPath;
    }

    /**
     * 设置生成路径
     *
     * @param genPath 生成路径
     */
    public void setGenPath(String genPath) {
        this.genPath = genPath;
    }

    /**
     * 获取主键列信息
     *
     * @return 主键列信息
     */
    public GenTableColumn getPkColumn() {
        return pkColumn;
    }

    /**
     * 设置主键列信息
     *
     * @param pkColumn 主键列信息
     */
    public void setPkColumn(GenTableColumn pkColumn) {
        this.pkColumn = pkColumn;
    }

    /**
     * 获取子表信息
     *
     * @return 子表信息
     */
    public GenTable getSubTable() {
        return subTable;
    }

    /**
     * 设置子表信息
     *
     * @param subTable 子表信息
     */
    public void setSubTable(GenTable subTable) {
        this.subTable = subTable;
    }

    /**
     * 获取列集合
     *
     * @return 列集合
     */
    public List<GenTableColumn> getColumns() {
        return columns;
    }

    /**
     * 设置列集合
     *
     * @param columns 列集合
     */
    public void setColumns(List<GenTableColumn> columns) {
        this.columns = columns;
    }

    /**
     * 获取其他选项
     *
     * @return 其他选项
     */
    public String getOptions() {
        return options;
    }

    /**
     * 设置其他选项
     *
     * @param options 其他选项
     */
    public void setOptions(String options) {
        this.options = options;
    }

    /**
     * 获取树编码字段
     *
     * @return 树编码字段
     */
    public String getTreeCode() {
        return treeCode;
    }

    /**
     * 设置树编码字段
     *
     * @param treeCode 树编码字段
     */
    public void setTreeCode(String treeCode) {
        this.treeCode = treeCode;
    }

    /**
     * 获取树父编码字段
     *
     * @return 树父编码字段
     */
    public String getTreeParentCode() {
        return treeParentCode;
    }

    /**
     * 设置树父编码字段
     *
     * @param treeParentCode 树父编码字段
     */
    public void setTreeParentCode(String treeParentCode) {
        this.treeParentCode = treeParentCode;
    }

    /**
     * 获取树名称字段
     *
     * @return 树名称字段
     */
    public String getTreeName() {
        return treeName;
    }

    /**
     * 设置树名称字段
     *
     * @param treeName 树名称字段
     */
    public void setTreeName(String treeName) {
        this.treeName = treeName;
    }

    /**
     * 获取上级菜单ID
     *
     * @return 上级菜单ID
     */
    public Long getParentMenuId() {
        return parentMenuId;
    }

    /**
     * 设置上级菜单ID
     *
     * @param parentMenuId 上级菜单ID
     */
    public void setParentMenuId(Long parentMenuId) {
        this.parentMenuId = parentMenuId;
    }

    /**
     * 获取上级菜单名称
     *
     * @return 上级菜单名称
     */
    public String getParentMenuName() {
        return parentMenuName;
    }

    /**
     * 设置上级菜单名称
     *
     * @param parentMenuName 上级菜单名称
     */
    public void setParentMenuName(String parentMenuName) {
        this.parentMenuName = parentMenuName;
    }

    /**
     * 判断是否是主子表模式
     *
     * @return true: 是主子表模式; false: 否
     */
    public boolean isSub() {
        return isSub(this.tplCategory);
    }

    /**
     * 判断指定模板类别是否为主子表模式
     *
     * @param tplCategory 模板类别
     * @return true: 是主子表模式; false: 否
     */
    public static boolean isSub(String tplCategory) {
        return tplCategory != null && StringUtils.equals(GenConstants.TPL_SUB, tplCategory);
    }

    /**
     * 判断是否是树形结构模式
     *
     * @return true: 是树形结构模式; false: 否
     */
    public boolean isTree() {
        return isTree(this.tplCategory);
    }

    /**
     * 判断指定模板类别是否为树形结构模式
     *
     * @param tplCategory 模板类别
     * @return true: 是树形结构模式; false: 否
     */
    public static boolean isTree(String tplCategory) {
        return tplCategory != null && StringUtils.equals(GenConstants.TPL_TREE, tplCategory);
    }

    /**
     * 判断是否是普通CRUD模式
     *
     * @return true: 是普通CRUD模式; false: 否
     */
    public boolean isCrud() {
        return isCrud(this.tplCategory);
    }

    /**
     * 判断指定模板类别是否为普通CRUD模式
     *
     * @param tplCategory 模板类别
     * @return true: 是普通CRUD模式; false: 否
     */
    public static boolean isCrud(String tplCategory) {
        return tplCategory != null && StringUtils.equals(GenConstants.TPL_CRUD, tplCategory);
    }

    /**
     * 判断某个Java字段是否属于超级列（即通用字段）
     *
     * @param javaField Java字段名
     * @return true: 属于超级列; false: 不属于
     */
    public boolean isSuperColumn(String javaField) {
        return isSuperColumn(this.tplCategory, javaField);
    }

    /**
     * 判断给定模板类别下某Java字段是否属于超级列
     *
     * @param tplCategory 模板类别
     * @param javaField   Java字段名
     * @return true: 属于超级列; false: 不属于
     */
    public static boolean isSuperColumn(String tplCategory, String javaField) {
        // 如果是树形结构，则同时检查TREE_ENTITY和BASE_ENTITY字段
        if (isTree(tplCategory)) {
            return StringUtils.equalsAnyIgnoreCase(javaField,
                    ArrayUtils.addAll(GenConstants.TREE_ENTITY, GenConstants.BASE_ENTITY));
        }
        // 否则只检查BASE_ENTITY字段
        return StringUtils.equalsAnyIgnoreCase(javaField, GenConstants.BASE_ENTITY);
    }
}
